Skip to content

Implement Models API Part #1#14533

Merged
azabbasi merged 15 commits into
masterfrom
feature/adt/azabbasi/secondIterationModelsAPI
Aug 31, 2020
Merged

Implement Models API Part #1#14533
azabbasi merged 15 commits into
masterfrom
feature/adt/azabbasi/secondIterationModelsAPI

Conversation

@azabbasi

Copy link
Copy Markdown
Contributor

No description provided.

@azabbasi azabbasi force-pushed the feature/adt/azabbasi/secondIterationModelsAPI branch from 3ae9dba to 68a49c1 Compare August 28, 2020 00:08
Comment thread sdk/digitaltwins/azure-digitaltwins-core/API design.md Outdated
Comment thread sdk/digitaltwins/azure-digitaltwins-core/API design.md Outdated
@azabbasi azabbasi changed the title Implement ListModels API Implement Models API Aug 28, 2020
@azabbasi azabbasi changed the title Implement Models API Implement Models API Part #1 Aug 28, 2020
* Gets a model, including the model metadata and the model definition asynchronously.
* @param modelId The Id of the model.
* @return A REST response containing the model.
* @return The ModelData and the http response

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have seen the format of "The Http response containing modelData"
We can decide one and use the same everywhere.


/**
* Gets a model, including the model metadata and the model definition.
* @param modelId The Id of the model.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unique Identifier?


/**
* Gets a model, including the model metadata and the model definition asynchronously.
* @param modelId The Id of the model.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same here as above and other places

* Creates one or many models.
* @param models The list of models to create. Each string corresponds to exactly one model.
* @return A REST response containing the list of created models.
* @return A {@link PagedIterable} of created ModelData.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add a comment about context too?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will only update the actual implementation from now on

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is part 2 suppose to contain?
Decommision and rest of it?

Decommission APIs and the Samples and tests.

Comment thread sdk/digitaltwins/azure-digitaltwins-core/API design.md Outdated
* @return A {@link PagedFlux} of ModelData and the http response.
*/
@ServiceMethod(returns = ReturnType.COLLECTION)
public PagedFlux<ModelData> listModels(ListModelOptions listModelOptions) { }

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same here, with response?

/**
* Deletes a model.
* @param modelId The id for the model. The id is globally unique and case sensitive.
* @return An empty Mono

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we even need to mention this return?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, we will get doc verification errors.

@bikamani bikamani left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is part 2 suppose to contain?
Decommision and rest of it?

@azabbasi azabbasi merged commit 1317e07 into master Aug 31, 2020
@azabbasi azabbasi deleted the feature/adt/azabbasi/secondIterationModelsAPI branch August 31, 2020 16:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants